﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class DxGridSummaryGroupItem
   </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class DxGridSummaryGroupItem
   ">
    <meta name="generator" content="docfx 2.59.2.0">
    
    <link rel="shortcut icon" href="../../favicon.ico">
    <link rel="stylesheet" href="../../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../../styles/docfx.css">
    <link rel="stylesheet" href="../../styles/main.css">
    <link rel="stylesheet" href="../../styles/socialbar.css">
    <link rel="stylesheet" href="../../styles/header.css">
    <link rel="stylesheet" href="../../styles/version.css">
    <link href="https://fonts.googleapis.com/css?family=Roboto:400,100,300,500,700,100italic,300italic,400italic" rel="stylesheet" type="text/css">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
    <meta property="docfx:navrel" content="../../toc.html">
    <meta property="docfx:tocrel" content="../toc.html">
    <meta property="docfx:uid" content="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem">
    
    <meta property="docfx:rel" content="../../">
    
    <script type="text/javascript" src="../../nav.js"></script>
    <script type="text/javascript" src="../toc.js"></script>
  
  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <div class="mb-socials-heading" style="height: 40px;">
        	<div class="mb-socials-heading-inner container">
        		<div class="mb-socials-heading-right">
        			<div class="mb-socials-list">
                          
        				<div class="mb-socials-item facebook">
        					<a class="mb-socials-item-link" target="_blank" href="https://facebook.com/embyapp"></a>
        					<div class="mb-socials-item-popup">
        						<span>Facebook</span>
        					</div>
        				</div><div class="mb-socials-item twitter">
        					<a class="mb-socials-item-link" target="_blank" href="https://twitter.com/embyapp"></a>
        					<div class="mb-socials-item-popup">
        						<span>Twitter</span>
        					</div>
        				</div>
        				<div class="mb-socials-item pinterest">
        					<a class="mb-socials-item-link" target="_blank" href="https://www.pinterest.com/emby0240/emby-news/"></a>
        					<div class="mb-socials-item-popup">
        						<span>Pinterest</span>
        					</div>
        				</div>
        				<div class="mb-socials-item tumblr">
        					<a class="mb-socials-item-link" target="_blank" href="https://embyapp.tumblr.com/"></a>
        					<div class="mb-socials-item-popup">
        						<span>Tumblr</span>
        					</div>
        				</div>
        				<div class="mb-socials-item github">
        					<a class="mb-socials-item-link" target="_blank" href="https://github.com/MediaBrowser"></a>
        					<div class="mb-socials-item-popup">
        						<span>GitHub</span>
        					</div>
        				</div><div class="mb-socials-item rss">
        					<a class="mb-socials-item-link" target="_blank" href="https://emby.media/blog.xml"></a>
        					<div class="mb-socials-item-popup">
        						<span>RSS</span>
        					</div>
        				</div>
                          
        			</div>
        		</div>
        	</div>
        </div>
        <div class="container">
        	<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
        		  
        		  <a class="navbar-brand" href="../../index.html">
        		    <img id="logo" class="svg" src="../../images/emby_dev_logo.png" alt="">
        		  </a>
        		  <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
        			<span class="sr-only">Toggle navigation</span>
        			<span class="icon-bar"></span>
        			<span class="icon-bar"></span>
        			<span class="icon-bar"></span>
        		  </button>
        		<div class="collapse navbar-collapse" id="navbar">
        			
        			<ul class="nav level1 navbar-nav">
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../index.html" title="DEV Home">DEV Home</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../doc/index.html" title="Documentation">Documentation</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../reference/index.html" title="Reference">Reference</a>
        			      </li>
        			      <li class="nav-item">
        			          <a class="nav-link" href="../../download/index.html" title="Download">Download</a>
        			      </li>
        			</ul>		</div>
        	</nav>
        </div>
        <div class="nav-overlay d-none"></div>        
        <div class="subnav navbar navbar-default">
          <div class="container">
            <div class="hide-when-search" id="breadcrumb">
        	  <ul class="breadcrumb">
        		<li></li>
        	  </ul>
        	</div>
        
        	<div class="breadcrumpsearch">
        	  <form class="navbar-form navbar-right" role="search" id="search">
        		<div class="form-group">
        		  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
        		</div>
        	  </form>
        	</div>
          </div>
        </div>
      </header>
      <div class="container body-content">
        
        <div id="search-results">
          <div class="search-list">Search Results for <span></span></div>
          <div class="sr-items">
            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
          </div>
          <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
        </div>
      </div>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem">
<div class="refdoc">
  
  
  <h1 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem" class="text-break">Class DxGridSummaryGroupItem
  </h1>
  <div class="markdown level0 summary"></div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">Object</a></div>
    <div class="level1"><span class="xref">DxGridSummaryGroupItem</span></div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="Emby.Web.GenericEdit.Elements.DxGrid.html">Emby.Web.GenericEdit.Elements.DxGrid</a></h6>
  <h6><strong>Assembly</strong>: Emby.Web.GenericEdit.dll</h6>
  <h5 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class DxGridSummaryGroupItem</code></pre>
  </div>
  <h3 id="properties">Properties
  </h3>
  
  
  <a id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_alignByColumn_" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.alignByColumn*"></a>
  <h4 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_alignByColumn" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.alignByColumn">alignByColumn</h4>
  <div class="markdown level1 summary"><p>Indicates whether to display group summary items in parentheses after the group row header or to align them by the corresponding columns within the group row.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool? alignByColumn { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a>&gt;</td>
        <td></td>
      </tr>
    </tbody>
  </table>
  
  
  <a id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_column_" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.column*"></a>
  <h4 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_column" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.column">column</h4>
  <div class="markdown level1 summary"><p>Specifies the column that provides data for a group summary item.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string column { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">String</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  
  
  <a id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_displayFormat_" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.displayFormat*"></a>
  <h4 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_displayFormat" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.displayFormat">displayFormat</h4>
  <div class="markdown level1 summary"><p>Specifies the summary item's text.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string displayFormat { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">String</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_displayFormat_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>You can use the following position markers in this text:</p>
<p>{0} - formatted summary value.
{1} - the parent column's caption. Available if the showInColumn option is specified.</p>
</div>
  
  
  <a id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_name_" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.name*"></a>
  <h4 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_name" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.name">name</h4>
  <div class="markdown level1 summary"><p>Specifies the group summary item's identifier.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string name { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">String</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_name_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>Use this name to access the summary item in callback functions like calculateCustomSummary.</p>
</div>
  
  
  <a id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_showInColumn_" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.showInColumn*"></a>
  <h4 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_showInColumn" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.showInColumn">showInColumn</h4>
  <div class="markdown level1 summary"><p>Specifies the column that must hold the summary item when this item is displayed in the group footer or aligned by a column in the group row.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool? showInColumn { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a>&gt;</td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_showInColumn_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>A group summary item can be forced to be displayed in the group row by the column that provides data for this item.
Alternatively, you can place an item to the group footer where the item is also held by the column that provides data for it.
If you need to place an item in another column, assign the name, data field or caption of this column to the showInColumn option.</p>
</div>
  
  
  <a id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_showInGroupFooter_" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.showInGroupFooter*"></a>
  <h4 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_showInGroupFooter" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.showInGroupFooter">showInGroupFooter</h4>
  <div class="markdown level1 summary"><p>pecifies whether or not a summary item must be displayed in the group footer.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool? showInGroupFooter { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a>&gt;</td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_showInGroupFooter_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>By default, summary items are displayed as a part of a group row. If you need a summary item to be displayed in the group footer,
assign true to the showInGroupFooter option of this item. This summary item will be located in the column that provides data for it.
If you want another column to hold the summary item, specify the showInColumn option of this item.</p>
</div>
  
  
  <a id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_skipEmptyValues_" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.skipEmptyValues*"></a>
  <h4 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_skipEmptyValues" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.skipEmptyValues">skipEmptyValues</h4>
  <div class="markdown level1 summary"><p>Specifies whether or not to skip empty strings, null and undefined values when calculating a summary.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool? skipEmptyValues { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a>&gt;</td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_skipEmptyValues_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>Specified in a summary configuration object, this option affects an individual summary item.
If you need to apply a single setting to all summaries in a grid,
specify the skipEmptyValues option in the summary object.</p>
</div>
  
  
  <a id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_summaryType_" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.summaryType*"></a>
  <h4 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_summaryType" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.summaryType">summaryType</h4>
  <div class="markdown level1 summary"><p>Specifies how to aggregate data for the group summary item.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public DxGridSummaryGroupItem.SummaryType? summaryType { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<a class="xref" href="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.SummaryType.html">DxGridSummaryGroupItem.SummaryType</a>&gt;</td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_summaryType_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>Use the SummaryType enum to specify this option when the widget is used as an ASP.NET MVC 5 Control or a DevExtreme-Based
ASP.NET Core Control. This enum accepts the following values: Sum, Min, Max, Avg, Count, and Custom.
To apply a custom server-side aggregate function, use a string overload instead.</p>
</div>
  
  
  <a id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_valueFormat_" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.valueFormat*"></a>
  <h4 id="Emby_Web_GenericEdit_Elements_DxGrid_DxGridSummaryGroupItem_valueFormat" data-uid="Emby.Web.GenericEdit.Elements.DxGrid.DxGridSummaryGroupItem.valueFormat">valueFormat</h4>
  <div class="markdown level1 summary"><p>Specifies a summary item value's display format.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string valueFormat { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">String</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h3 id="extensionmethods">Extension Methods</h3>
  <div>
      <a class="xref" href="Emby.Media.Common.Extensions.Extensions.html#Emby_Media_Common_Extensions_Extensions_JsonClone__1___0_MediaBrowser_Model_Serialization_IJsonSerializer_">Extensions.JsonClone&lt;T&gt;(T, IJsonSerializer)</a>
  </div>
</div>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                </ul>
              </div>
              <div class="sdkversion Release">
                  SDK <span class="sdkVersionSpan"></span>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>On this Page</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to Top</a>
            </span>
            Copyright 2022 © EMBY LLC.  Please see our <a class="lnk" href="https://emby.media/terms.html">terms of use</a> and <a class="lnk" href="https://emby.media/privacy.html">privacy policy</a>.
            
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../../searchIndex.js"></script>
    <script type="text/javascript" src="../../styles/lunr.min.js"></script>
    <script type="text/javascript" src="../../styles/docfx.js"></script>
    <script type="text/javascript" src="../../styles/main.js"></script>
  </body>
</html>
